Git submodule 的使用

Git 子模块（Git Submodule）是一种在 Git 仓库中嵌套使用其他 Git 仓库的方式。它允许将一个 Git 仓库作为另一个 Git 仓库的子目录，使得两个项目能够独立地进行开发和维护。

使用 Git 子模块有助于在一个项目中引入外部依赖，而不必将这些依赖完全合并到主项目中。这对于管理复杂的项目结构和共享代码库非常有用。

以下是如何使用 Git 子模块的一般步骤：

添加子模块：假设你有一个主项目（称为父项目），而你想要将另一个 Git 仓库（称为子项目）作为子模块添加到主项目中。

在主项目的根目录执行以下命令来添加子模块：

git submodule add <URL to submodule repository> <path/to/submodule/directory>

<URL to submodule repository>：子模块的 Git 仓库 URL。
<path/to/submodule/directory>：在主项目中子模块的存放路径。

提交更改：添加子模块后，主项目的状态会发生变化，因此需要提交这些更改到主项目的仓库中：

git commit -m "Added submodule: <submodule_name>"

克隆包含子模块的项目：如果其他开发者克隆了包含子模块的主项目，他们需要初始化和更新子模块：

git clone <URL to main repository>
cd main_repository
git submodule update --init --recursive

或者，如果他们已经克隆了主项目，可以运行以下命令初始化和更新子模块：

git submodule update --init --recursive

更新子模块：如果子模块的远程仓库有了新的提交，你可以在主项目中使用以下命令来更新子模块：

git submodule update --remote <path/to/submodule/directory>

提交子模块更新：在主项目中进行子模块更新后，需要将这些更改提交到主项目的仓库中：

cd <path/to/submodule/directory>
git checkout master  # 切换到子模块的主分支
git pull origin master  # 将子模块更新到最新版本
cd ..  # 返回到主项目根目录
git add <path/to/submodule/directory>
git commit -m "Updated submodule: <submodule_name>"

移除子模块：如果你想要移除子模块，可以执行以下命令：

git submodule deinit <path/to/submodule/directory>
git rm <path/to/submodule/directory>
rm -rf .git/modules/<path/to/submodule/directory>

然后提交这些更改：

git commit -m "Removed submodule: <submodule_name>"

请注意，子模块在 Git 中并不是一种特别简单的机制，它涉及到多个步骤和仓库之间的关联。因此，在使用子模块时要特别注意，确保所有开发者都理解如何初始化和更新子模块，并且避免在子模块中直接进行修改等操作，以免造成冲突和不稳定性。

References

Git submodule 子模块的管理和使用

References​

References